GET FormTypes?assetTypeId={assetTypeId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves form types for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetTypeId |
Id of the asset type |
globally unique identifier |
None. |
take |
Number of form types to retrieve. Default is all form types |
integer |
None. |
skip |
Number of form types to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the form types before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of form types.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of FormType |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "FormTypeId": "0ea89073-a149-4906-9f71-88bf8ca507ec", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "82181ed0-a95c-4569-9145-575f6fd456c4", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c8652ebd-bf2d-4949-b60d-04c891f6da51", "CreateDate": "2024-05-06T19:48:26.0473502-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T19:48:26.0473502-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-05-06T19:48:26.0473502-07:00", "Fields": [ { "FormTypeFieldId": "24e9a510-c7cc-4f42-b098-b5733c274701", "Section": { "FormTypeSectionId": "de478a14-d135-4447-8b72-4f314d5c31c5", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "f0e7b447-f4b2-4100-84d2-637f9259a4fd", "Name": "sample string 1" }, "Unit": { "UnitId": "b08638d5-ea5e-4edd-98de-a5ec4083b91c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "34405456-b1a8-4ae1-bd7e-516601500b3f", "CreateDate": "2024-05-06T19:48:26.0473502-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T19:48:26.0473502-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" }, { "FormTypeFieldId": "24e9a510-c7cc-4f42-b098-b5733c274701", "Section": { "FormTypeSectionId": "de478a14-d135-4447-8b72-4f314d5c31c5", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "f0e7b447-f4b2-4100-84d2-637f9259a4fd", "Name": "sample string 1" }, "Unit": { "UnitId": "b08638d5-ea5e-4edd-98de-a5ec4083b91c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "34405456-b1a8-4ae1-bd7e-516601500b3f", "CreateDate": "2024-05-06T19:48:26.0473502-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T19:48:26.0473502-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" } ], "SourceSystemId": "sample string 3", "CompanyId": "1432a4fc-4b66-469a-92d7-088cade23307", "CreateDate": "2024-05-06T19:48:26.0473502-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T19:48:26.0473502-07:00", "LastModifiedUser": "sample string 6" }, { "FormTypeId": "0ea89073-a149-4906-9f71-88bf8ca507ec", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "82181ed0-a95c-4569-9145-575f6fd456c4", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c8652ebd-bf2d-4949-b60d-04c891f6da51", "CreateDate": "2024-05-06T19:48:26.0473502-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T19:48:26.0473502-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-05-06T19:48:26.0473502-07:00", "Fields": [ { "FormTypeFieldId": "24e9a510-c7cc-4f42-b098-b5733c274701", "Section": { "FormTypeSectionId": "de478a14-d135-4447-8b72-4f314d5c31c5", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "f0e7b447-f4b2-4100-84d2-637f9259a4fd", "Name": "sample string 1" }, "Unit": { "UnitId": "b08638d5-ea5e-4edd-98de-a5ec4083b91c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "34405456-b1a8-4ae1-bd7e-516601500b3f", "CreateDate": "2024-05-06T19:48:26.0473502-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T19:48:26.0473502-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" }, { "FormTypeFieldId": "24e9a510-c7cc-4f42-b098-b5733c274701", "Section": { "FormTypeSectionId": "de478a14-d135-4447-8b72-4f314d5c31c5", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "f0e7b447-f4b2-4100-84d2-637f9259a4fd", "Name": "sample string 1" }, "Unit": { "UnitId": "b08638d5-ea5e-4edd-98de-a5ec4083b91c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "34405456-b1a8-4ae1-bd7e-516601500b3f", "CreateDate": "2024-05-06T19:48:26.0473502-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T19:48:26.0473502-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" } ], "SourceSystemId": "sample string 3", "CompanyId": "1432a4fc-4b66-469a-92d7-088cade23307", "CreateDate": "2024-05-06T19:48:26.0473502-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T19:48:26.0473502-07:00", "LastModifiedUser": "sample string 6" } ], "Total": 1, "Message": "sample string 1" }